<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libxlsxwriter: lxw_comment_options Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">libxlsxwriter
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">lxw_comment_options Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Options for inserted comments.  
 <a href="structlxw__comment__options.html#details">More...</a></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Options for modifying comments inserted via <code><a class="el" href="worksheet_8h.html#a158dadac385cd1007994e5478b7b2aa7" title="Write a comment to a worksheet cell with options.">worksheet_write_comment_opt()</a></code>. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="comments2_8c-example.html#_a14">comments2.c</a>.</dd>
</dl>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a3a3399ada29d05d2e7702e881fbe3ccb"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__comment__options.html#a3a3399ada29d05d2e7702e881fbe3ccb">visible</a></td></tr>
<tr class="separator:a3a3399ada29d05d2e7702e881fbe3ccb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5b73a7c784616e582aba3f3f7ae56d9"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__comment__options.html#ac5b73a7c784616e582aba3f3f7ae56d9">author</a></td></tr>
<tr class="separator:ac5b73a7c784616e582aba3f3f7ae56d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc75ab267fe81d828844e6a619c7edef"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__comment__options.html#abc75ab267fe81d828844e6a619c7edef">width</a></td></tr>
<tr class="separator:abc75ab267fe81d828844e6a619c7edef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab536125829ddfea261406141685cd868"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__comment__options.html#ab536125829ddfea261406141685cd868">height</a></td></tr>
<tr class="separator:ab536125829ddfea261406141685cd868"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6fe2a539fa5448c499fbbbef3215976c"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__comment__options.html#a6fe2a539fa5448c499fbbbef3215976c">x_scale</a></td></tr>
<tr class="separator:a6fe2a539fa5448c499fbbbef3215976c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5cdcb6a45356c37c44c9601117e64a0"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__comment__options.html#aa5cdcb6a45356c37c44c9601117e64a0">y_scale</a></td></tr>
<tr class="separator:aa5cdcb6a45356c37c44c9601117e64a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89a37846d06f3d06efb1c7b6d7dd96e8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="format_8h.html#a34a05058edd856109e5bcf1cc6739fc9">lxw_color_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__comment__options.html#a89a37846d06f3d06efb1c7b6d7dd96e8">color</a></td></tr>
<tr class="separator:a89a37846d06f3d06efb1c7b6d7dd96e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81608aa6e7816544847c1a74beb0f34d"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__comment__options.html#a81608aa6e7816544847c1a74beb0f34d">font_name</a></td></tr>
<tr class="separator:a81608aa6e7816544847c1a74beb0f34d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac17bcd6bb0f71289e51e030198ce7db3"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__comment__options.html#ac17bcd6bb0f71289e51e030198ce7db3">font_size</a></td></tr>
<tr class="separator:ac17bcd6bb0f71289e51e030198ce7db3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae26ce8cbacfcff2967944e7c97cdfdfe"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__comment__options.html#ae26ce8cbacfcff2967944e7c97cdfdfe">font_family</a></td></tr>
<tr class="separator:ae26ce8cbacfcff2967944e7c97cdfdfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1360f4a255e8c255b3759d44205de938"><td class="memItemLeft" align="right" valign="top"><a class="el" href="common_8h.html#aaf33b4e2179dcc466359277210774ce3">lxw_row_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__comment__options.html#a1360f4a255e8c255b3759d44205de938">start_row</a></td></tr>
<tr class="separator:a1360f4a255e8c255b3759d44205de938"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0cd41b5c72fe32c545c1531ae7a9e4e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="common_8h.html#a4fedd8dede664b070e84e850a3f92fd2">lxw_col_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__comment__options.html#af0cd41b5c72fe32c545c1531ae7a9e4e">start_col</a></td></tr>
<tr class="separator:af0cd41b5c72fe32c545c1531ae7a9e4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85ea5b7a9deceb6b5dd9b1580b49b5a5"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__comment__options.html#a85ea5b7a9deceb6b5dd9b1580b49b5a5">x_offset</a></td></tr>
<tr class="separator:a85ea5b7a9deceb6b5dd9b1580b49b5a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e8377d5a572091fba48f5484a14a249"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__comment__options.html#a6e8377d5a572091fba48f5484a14a249">y_offset</a></td></tr>
<tr class="separator:a6e8377d5a572091fba48f5484a14a249"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a id="a3a3399ada29d05d2e7702e881fbe3ccb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a3399ada29d05d2e7702e881fbe3ccb">&#9670;&nbsp;</a></span>visible</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t lxw_comment_options::visible</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This option is used to make a cell comment visible when the worksheet is opened. The default behavior in Excel is that comments are initially hidden. However, it is also possible in Excel to make individual comments or all comments visible. You can make all comments in the worksheet visible using the <code><a class="el" href="worksheet_8h.html#aafb945c6f7f462e7c6eb24032ea4e61a" title="Make all comments in the worksheet visible.">worksheet_show_comments()</a></code> function. Defaults to LXW_COMMENT_DISPLAY_DEFAULT. See also <a class="el" href="working_with_comments.html#ww_comments_visible">Cell comments: visible</a>. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="comments2_8c-example.html#a15">comments2.c</a>.</dd>
</dl>

</div>
</div>
<a id="ac5b73a7c784616e582aba3f3f7ae56d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac5b73a7c784616e582aba3f3f7ae56d9">&#9670;&nbsp;</a></span>author</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* lxw_comment_options::author</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This option is used to indicate the author of the cell comment. Excel displays the author in the status bar at the bottom of the worksheet. The default author for all cell comments in a worksheet can be set using the <code><a class="el" href="worksheet_8h.html#af196b0cb611f3abc800f3439f3bb8942" title="Set the default author of the cell comments.">worksheet_set_comments_author()</a></code> function. Set to NULL if not required. See also <a class="el" href="working_with_comments.html#ww_comments_author">Cell comments: author</a>. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="comments2_8c-example.html#a27">comments2.c</a>.</dd>
</dl>

</div>
</div>
<a id="abc75ab267fe81d828844e6a619c7edef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc75ab267fe81d828844e6a619c7edef">&#9670;&nbsp;</a></span>width</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint16_t lxw_comment_options::width</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This option is used to set the width of the cell comment box explicitly in pixels. The default width is 128 pixels. See also <a class="el" href="working_with_comments.html#ww_comments_width">Cell comments: width</a>. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="comments2_8c-example.html#a22">comments2.c</a>.</dd>
</dl>

</div>
</div>
<a id="ab536125829ddfea261406141685cd868"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab536125829ddfea261406141685cd868">&#9670;&nbsp;</a></span>height</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint16_t lxw_comment_options::height</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This option is used to set the height of the cell comment box explicitly in pixels. The default height is 74 pixels. See also <a class="el" href="working_with_comments.html#ww_comments_height">Cell comments: height</a>. </p>

</div>
</div>
<a id="a6fe2a539fa5448c499fbbbef3215976c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6fe2a539fa5448c499fbbbef3215976c">&#9670;&nbsp;</a></span>x_scale</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double lxw_comment_options::x_scale</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>X scale of the comment as a decimal. See also <a class="el" href="working_with_comments.html#ww_comments_x_scale">Cell comments: x_scale</a>. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="comments2_8c-example.html#a20">comments2.c</a>.</dd>
</dl>

</div>
</div>
<a id="aa5cdcb6a45356c37c44c9601117e64a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5cdcb6a45356c37c44c9601117e64a0">&#9670;&nbsp;</a></span>y_scale</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double lxw_comment_options::y_scale</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Y scale of the comment as a decimal. See also <a class="el" href="working_with_comments.html#ww_comments_y_scale">Cell comments: y_scale</a>. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="comments2_8c-example.html#a21">comments2.c</a>.</dd>
</dl>

</div>
</div>
<a id="a89a37846d06f3d06efb1c7b6d7dd96e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89a37846d06f3d06efb1c7b6d7dd96e8">&#9670;&nbsp;</a></span>color</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="format_8h.html#a34a05058edd856109e5bcf1cc6739fc9">lxw_color_t</a> lxw_comment_options::color</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This option is used to set the background color of cell comment box. The color should be an RGB integer value, see <a class="el" href="working_with_colors.html">Working with Colors</a>. See also <a class="el" href="working_with_comments.html#ww_comments_color">Cell comments: color</a>. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="comments2_8c-example.html#a25">comments2.c</a>.</dd>
</dl>

</div>
</div>
<a id="a81608aa6e7816544847c1a74beb0f34d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a81608aa6e7816544847c1a74beb0f34d">&#9670;&nbsp;</a></span>font_name</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* lxw_comment_options::font_name</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This option is used to set the font for the comment. The default font is 'Tahoma'. See also <a class="el" href="working_with_comments.html#ww_comments_font_name">Cell comments: font_name</a>. </p>

</div>
</div>
<a id="ac17bcd6bb0f71289e51e030198ce7db3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac17bcd6bb0f71289e51e030198ce7db3">&#9670;&nbsp;</a></span>font_size</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double lxw_comment_options::font_size</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This option is used to set the font size for the comment. The default is 8. See also <a class="el" href="working_with_comments.html#ww_comments_font_size">Cell comments: font_size</a>. </p>

</div>
</div>
<a id="ae26ce8cbacfcff2967944e7c97cdfdfe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae26ce8cbacfcff2967944e7c97cdfdfe">&#9670;&nbsp;</a></span>font_family</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t lxw_comment_options::font_family</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This option is used to set the font family number for the comment. Not required very often. Set to 0. </p>

</div>
</div>
<a id="a1360f4a255e8c255b3759d44205de938"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1360f4a255e8c255b3759d44205de938">&#9670;&nbsp;</a></span>start_row</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="common_8h.html#aaf33b4e2179dcc466359277210774ce3">lxw_row_t</a> lxw_comment_options::start_row</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This option is used to set the row in which the comment will appear. By default Excel displays comments one cell to the right and one cell above the cell to which the comment relates. The <code>start_row</code> and <code>start_col</code> options should both be set to 0 if not used. See also <a class="el" href="working_with_comments.html#ww_comments_start_row">Cell comments: start_row</a>. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="comments2_8c-example.html#a23">comments2.c</a>.</dd>
</dl>

</div>
</div>
<a id="af0cd41b5c72fe32c545c1531ae7a9e4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af0cd41b5c72fe32c545c1531ae7a9e4e">&#9670;&nbsp;</a></span>start_col</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="common_8h.html#a4fedd8dede664b070e84e850a3f92fd2">lxw_col_t</a> lxw_comment_options::start_col</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This option is used to set the column in which the comment will appear. See the <code>start_row</code> option for more information and see also <a class="el" href="working_with_comments.html#ww_comments_start_col">Cell comments: start_col</a>. </p>

</div>
</div>
<a id="a85ea5b7a9deceb6b5dd9b1580b49b5a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85ea5b7a9deceb6b5dd9b1580b49b5a5">&#9670;&nbsp;</a></span>x_offset</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t lxw_comment_options::x_offset</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Offset from the left of the cell in pixels. See also <a class="el" href="working_with_comments.html#ww_comments_x_offset">Cell comments: x_offset</a>. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="comments2_8c-example.html#a24">comments2.c</a>.</dd>
</dl>

</div>
</div>
<a id="a6e8377d5a572091fba48f5484a14a249"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e8377d5a572091fba48f5484a14a249">&#9670;&nbsp;</a></span>y_offset</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t lxw_comment_options::y_offset</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Offset from the top of the cell in pixels. See also <a class="el" href="working_with_comments.html#ww_comments_y_offset">Cell comments: y_offset</a>. </p>

</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.20-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Copyright 2014-2020 John McNamara.
Generated by&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
</small></address>
</body>
</html>
